/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.parser.clauses;

/**
 * Specifica un campo di raggruppamento
 */
public class HLGroupByField {

	/**
	 * La sorgente dati a cui il campo appartiene
	 */
	private FromSource fromSource;
	
	/**
	 * Il nome del campo su cui si andra' a fare il raggruppamento
	 */
	private String fieldName;

	
	/**
	 * Restituisce la sorgente dati a cui il campo appartiene
	 */
	public FromSource getFromSource()
	{
		return this.fromSource;
	}
	
	/**
	 * Imposta la sorgente dati a cui il campo appartiene
	 */
	public void setFromSource(FromSource fromSource)
	{
		this.fromSource = fromSource;
	}	
	
	/**
	 * Restituisce il nome del campo su cui si andra' a fare il raggruppamento 
	 */
	public String getFieldName() {
		return this.fieldName;
	}

	/**
	 * Imposta il nome del campo su cui si andra' a fare il raggruppamento
	 */
	public void setFieldName(String fieldName) {
		this.fieldName = fieldName;
	}
	
	/**
	 * Restituisce lo spezzone di codice "perla" corrispondente
	 */
	public String toString() {
		String stringToReturn = "";
		
		// Aggiunge l'alias della sorgente dati
		if((this.fromSource == null) || (this.fromSource.getAlias() == null))
			stringToReturn += "<alias>";
		else
			stringToReturn += this.fromSource.getAlias();
			
		// Aggiunge il punto di separazione
		stringToReturn += ".";
		
		// Aggiunge il nome del campo
		if(this.fieldName == null)
			stringToReturn += "<field_name>";
		else
			stringToReturn += this.fieldName;
		
		// Ritorna la stringa costruita
		return stringToReturn;
	}
}
